Create master branch via GitHub

This commit is contained in:
Dylan Araps 2016-12-09 17:59:19 +11:00 committed by GitHub
parent 56c445977e
commit f47c108b1f
2 changed files with 91 additions and 13 deletions

View File

@ -19,30 +19,108 @@
</section> </section>
<section class="main-content"> <section class="main-content">
<h3> <h1>
<a id="welcome-to-github-pages" class="anchor" href="#welcome-to-github-pages" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Welcome to GitHub Pages.</h3> <a id="neofetch" class="anchor" href="#neofetch" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Neofetch</h1>
<p>This automatic page generator is the easiest way to create beautiful pages for all of your projects. Author your page content here <a href="https://guides.github.com/features/mastering-markdown/">using GitHub Flavored Markdown</a>, select a template crafted by a designer, and publish. After your page is generated, you can check out the new <code>gh-pages</code> branch locally. If youre using GitHub Desktop, simply sync your repository and youll see the new branch.</p> <p><a href="https://gitter.im/dylanaraps/fetch?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge"><img src="https://badges.gitter.im/dylanaraps/fetch.svg" alt="Gitter"></a> <a href="https://travis-ci.org/dylanaraps/neofetch"><img src="https://travis-ci.org/dylanaraps/neofetch.svg?branch=master" alt="Build Status"></a> <a href="./LICENSE.md"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="MIT licensed"></a> <a href="https://github.com/dylanaraps/neofetch/releases"><img src="https://img.shields.io/github/release/dylanaraps/neofetch.svg" alt="Latest release"></a></p>
<p>Neofetch is a CLI system information tool written in BASH. Neofetch displays information about your system next to an image, your OS logo, or any ascii file of your choice. The main purpose of neofetch is to be used in screenshots to show other users what OS/Distro you're running, what Theme/Icons you're using and etc.</p>
<p>Neofetch is highly customizable through the use of commandline flags or the user config file. There are over 50 config options to mess around with and there's the <code>print_info()</code> function and friends which let you add your own custom info.</p>
<p>Neofetch can be used on any OS that has BASH, it's just a matter of adding support. If your OS/Distro isn't in the list below, feel free to open an issue on the repo and I'll gladly add support. Neofetch currently supports <code>Linux</code>, <code>MacOS</code>, <code>iOS</code>, <code>BSD</code>, <code>Solaris</code>, <code>Android</code>, <code>Haiku</code>, <code>GNU Hurd</code> and <code>Windows (Cygwin/Windows 10 Linux subsystem)</code>.</p>
<p>For more information:</p>
<p><strong><a href="https://github.com/dylanaraps/neofetch/wiki">https://github.com/dylanaraps/neofetch/wiki</a></strong></p>
<p><img src="https://ipfs.pics/ipfs/QmTtF9Sx8o617QE88GH3Z4yX7mRyi4yS1hsMHyRVmn14vJ" alt="1"></p>
<h2>
<a id="dependencies" class="anchor" href="#dependencies" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Dependencies</h2>
<p><a href="https://github.com/dylanaraps/neofetch/wiki/Dependencies">https://github.com/dylanaraps/neofetch/wiki/Dependencies</a></p>
<h2>
<a id="installation" class="anchor" href="#installation" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Installation</h2>
<p><a href="https://github.com/dylanaraps/neofetch/wiki/Installation">https://github.com/dylanaraps/neofetch/wiki/Installation</a></p>
<h2>
<a id="post-install" class="anchor" href="#post-install" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Post Install</h2>
<h3> <h3>
<a id="designer-templates" class="anchor" href="#designer-templates" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Designer Templates</h3> <a id="using-the-config-file" class="anchor" href="#using-the-config-file" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Using the config file</h3>
<p>Weve crafted some handsome templates for you to use. Go ahead and click 'Continue to layouts' to browse through them. You can easily go back to edit your page before publishing. After publishing your page, you can revisit the page generator and switch to another theme. Your Page content will be preserved.</p> <p>Neofetch will by default create a config file at <code>$HOME/.config/neofetch/config</code> and this file contains all of the script's options/settings. The config file allows you to keep your customizations between script versions and allows you to easily share your customizations with other people.</p>
<p>You can launch the script without a config file by using the flag <code>--config none</code> and you can specify a custom config location using <code>--config path/to/config</code>.</p>
<p>See this wiki page for the default config: <a href="https://github.com/dylanaraps/neofetch/wiki/Config-File">https://github.com/dylanaraps/neofetch/wiki/Config-File</a></p>
<h3> <h3>
<a id="creating-pages-manually" class="anchor" href="#creating-pages-manually" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Creating pages manually</h3> <a id="customizing-what-info-gets-displayed" class="anchor" href="#customizing-what-info-gets-displayed" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Customizing what info gets displayed</h3>
<p>If you prefer to not use the automatic generator, push a branch named <code>gh-pages</code> to your repository to create a page manually. In addition to supporting regular HTML content, GitHub Pages support Jekyll, a simple, blog aware static site generator. Jekyll makes it easy to create site-wide headers and footers without having to copy them across every page. It also offers intelligent blog support and other advanced templating features.</p> <p><a href="https://github.com/dylanaraps/neofetch/wiki/Customizing-Info">https://github.com/dylanaraps/neofetch/wiki/Customizing-Info</a></p>
<h3> <h3>
<a id="authors-and-contributors" class="anchor" href="#authors-and-contributors" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Authors and Contributors</h3> <a id="customizing-the-script-using-a-custom-alias" class="anchor" href="#customizing-the-script-using-a-custom-alias" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Customizing the script using a custom alias</h3>
<p>You can @mention a GitHub username to generate a link to their profile. The resulting <code>&lt;a&gt;</code> element will link to the contributors GitHub Profile. For example: In 2007, Chris Wanstrath (<a href="https://github.com/defunkt" class="user-mention">@defunkt</a>), PJ Hyett (<a href="https://github.com/pjhyett" class="user-mention">@pjhyett</a>), and Tom Preston-Werner (<a href="https://github.com/mojombo" class="user-mention">@mojombo</a>) founded GitHub.</p> <p>If you don't want to use the config file you can customize almost everything using launch flags!</p>
<h3> <p>Here's an example neofetch alias:</p>
<a id="support-or-contact" class="anchor" href="#support-or-contact" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Support or Contact</h3>
<p>Having trouble with Pages? Check out our <a href="https://help.github.com/pages">documentation</a> or <a href="https://github.com/contact">contact support</a> and well help you sort it out.</p> <div class="highlight highlight-source-shell"><pre><span class="pl-c1">alias</span> neofetch2=<span class="pl-s"><span class="pl-pds">"</span>neofetch <span class="pl-cce">\</span></span>
<span class="pl-s">--config off <span class="pl-cce">\</span></span>
<span class="pl-s">--block_range 1 8 <span class="pl-cce">\</span></span>
<span class="pl-s">--bold off <span class="pl-cce">\</span></span>
<span class="pl-s">--uptime_shorthand on <span class="pl-cce">\</span></span>
<span class="pl-s">--gtk_shorthand on <span class="pl-cce">\</span></span>
<span class="pl-s">--colors 4 1 8 8 8 7 <span class="pl-cce">\</span></span>
<span class="pl-s"><span class="pl-pds">"</span></span></pre></div>
<h2>
<a id="thanks" class="anchor" href="#thanks" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Thanks</h2>
<p>Thanks to:</p>
<ul>
<li>
<a href="https://github.com/dylanaraps/neofetch/contributors">Contributors</a>
<ul>
<li>Thanks for making Neofetch better, I really appreciate it.</li>
</ul>
</li>
<li>
<a href="https://github.com/dylanaraps/neofetch/issues/115">Packagers</a>
<ul>
<li>Thanks for maintaining Neofetch packages.</li>
</ul>
</li>
<li>Users
<ul>
<li>Thanks for using my script!</li>
</ul>
</li>
<li>
<a href="https://github.com/KittyKatt/screenFetch">Screenfetch</a>:
<ul>
<li>I've used some snippets as a base for a few functions in this script.</li>
<li>Some of the ascii logos.</li>
</ul>
</li>
<li>
<a href="https://github.com/jschx/ufetch">ufetch</a>:
<ul>
<li>Tiny ascii logos</li>
</ul>
</li>
</ul>
<footer class="site-footer"> <footer class="site-footer">
<span class="site-footer-owner"><a href="https://github.com/dylanaraps/neofetch">Neofetch</a> is maintained by <a href="https://github.com/dylanaraps">dylanaraps</a>.</span> <span class="site-footer-owner"><a href="https://github.com/dylanaraps/neofetch">Neofetch</a> is maintained by <a href="https://github.com/dylanaraps">dylanaraps</a>.</span>

View File

@ -1,6 +1,6 @@
{ {
"name": "Neofetch", "name": "Neofetch",
"tagline": "A fast, highly customizable system info script that supports Linux, MacOS, iOS, BSD, Solaris, Android, Haiku, GNU Hurd and Windows (Cygwin/Windows 10 Linux subsystem)", "tagline": "A fast, highly customizable system info script that supports Linux, MacOS, iOS, BSD, Solaris, Android, Haiku, GNU Hurd and Windows (Cygwin/Windows 10 Linux subsystem)",
"body": "### Welcome to GitHub Pages.\r\nThis automatic page generator is the easiest way to create beautiful pages for all of your projects. Author your page content here [using GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/), select a template crafted by a designer, and publish. After your page is generated, you can check out the new `gh-pages` branch locally. If youre using GitHub Desktop, simply sync your repository and youll see the new branch.\r\n\r\n### Designer Templates\r\nWeve crafted some handsome templates for you to use. Go ahead and click 'Continue to layouts' to browse through them. You can easily go back to edit your page before publishing. After publishing your page, you can revisit the page generator and switch to another theme. Your Page content will be preserved.\r\n\r\n### Creating pages manually\r\nIf you prefer to not use the automatic generator, push a branch named `gh-pages` to your repository to create a page manually. In addition to supporting regular HTML content, GitHub Pages support Jekyll, a simple, blog aware static site generator. Jekyll makes it easy to create site-wide headers and footers without having to copy them across every page. It also offers intelligent blog support and other advanced templating features.\r\n\r\n### Authors and Contributors\r\nYou can @mention a GitHub username to generate a link to their profile. The resulting `<a>` element will link to the contributors GitHub Profile. For example: In 2007, Chris Wanstrath (@defunkt), PJ Hyett (@pjhyett), and Tom Preston-Werner (@mojombo) founded GitHub.\r\n\r\n### Support or Contact\r\nHaving trouble with Pages? Check out our [documentation](https://help.github.com/pages) or [contact support](https://github.com/contact) and well help you sort it out.\r\n", "body": "# Neofetch\r\n\r\n[![Gitter](https://badges.gitter.im/dylanaraps/fetch.svg)](https://gitter.im/dylanaraps/fetch?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![Build Status](https://travis-ci.org/dylanaraps/neofetch.svg?branch=master)](https://travis-ci.org/dylanaraps/neofetch) [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.md) [![Latest release](https://img.shields.io/github/release/dylanaraps/neofetch.svg)](https://github.com/dylanaraps/neofetch/releases)\r\n\r\nNeofetch is a CLI system information tool written in BASH. Neofetch displays information about your system next to an image, your OS logo, or any ascii file of your choice. The main purpose of neofetch is to be used in screenshots to show other users what OS/Distro you're running, what Theme/Icons you're using and etc.\r\n\r\nNeofetch is highly customizable through the use of commandline flags or the user config file. There are over 50 config options to mess around with and there's the `print_info()` function and friends which let you add your own custom info.\r\n\r\nNeofetch can be used on any OS that has BASH, it's just a matter of adding support. If your OS/Distro isn't in the list below, feel free to open an issue on the repo and I'll gladly add support. Neofetch currently supports `Linux`, `MacOS`, `iOS`, `BSD`, `Solaris`, `Android`, `Haiku`, `GNU Hurd` and `Windows (Cygwin/Windows 10 Linux subsystem)`.\r\n\r\nFor more information:\r\n\r\n**https://github.com/dylanaraps/neofetch/wiki**\r\n\r\n![1](https://ipfs.pics/ipfs/QmTtF9Sx8o617QE88GH3Z4yX7mRyi4yS1hsMHyRVmn14vJ)\r\n\r\n\r\n## Dependencies\r\n\r\nhttps://github.com/dylanaraps/neofetch/wiki/Dependencies\r\n\r\n\r\n## Installation\r\n\r\nhttps://github.com/dylanaraps/neofetch/wiki/Installation\r\n\r\n\r\n## Post Install\r\n\r\n\r\n### Using the config file\r\n\r\nNeofetch will by default create a config file at `$HOME/.config/neofetch/config` and this file contains all of the script's options/settings. The config file allows you to keep your customizations between script versions and allows you to easily share your customizations with other people.\r\n\r\nYou can launch the script without a config file by using the flag `--config none` and you can specify a custom config location using `--config path/to/config`.\r\n\r\nSee this wiki page for the default config: https://github.com/dylanaraps/neofetch/wiki/Config-File\r\n\r\n\r\n### Customizing what info gets displayed\r\n\r\nhttps://github.com/dylanaraps/neofetch/wiki/Customizing-Info\r\n\r\n\r\n### Customizing the script using a custom alias\r\n\r\nIf you don't want to use the config file you can customize almost everything using launch flags!\r\n\r\nHere's an example neofetch alias:\r\n\r\n```sh\r\nalias neofetch2=\"neofetch \\\r\n--config off \\\r\n--block_range 1 8 \\\r\n--bold off \\\r\n--uptime_shorthand on \\\r\n--gtk_shorthand on \\\r\n--colors 4 1 8 8 8 7 \\\r\n\"\r\n```\r\n\r\n\r\n## Thanks\r\n\r\nThanks to:\r\n\r\n- [Contributors](https://github.com/dylanaraps/neofetch/contributors)\r\n - Thanks for making Neofetch better, I really appreciate it.\r\n- [Packagers](https://github.com/dylanaraps/neofetch/issues/115)\r\n - Thanks for maintaining Neofetch packages.\r\n- Users\r\n - Thanks for using my script!\r\n- [Screenfetch](https://github.com/KittyKatt/screenFetch):\r\n - I've used some snippets as a base for a few functions in this script.\r\n - Some of the ascii logos.\r\n- [ufetch](https://github.com/jschx/ufetch):\r\n - Tiny ascii logos\r\n",
"note": "Don't delete this file! It's used internally to help with page regeneration." "note": "Don't delete this file! It's used internally to help with page regeneration."
} }