antoniomnds / novathesis-webconfig Goto Github PK

Fill the LICENSE.md file with a license. More about licenses at:

• https://help.github.com/articles/licensing-a-repository/
• https://choosealicense.com/

Creating documentation

GitHub Pages is a powerful tool that creates a static web page for GitHub repositories. GitHub Pages looks for an index.html or index.md file, but will also use a README.md file as the home page for the web page.

You can choose to have GitHub Pages look at the master branch, the gh-pages branch, or the /docs directory of the master branch.

⌨️ Activity: Enabling GitHub Pages for Documentation

1. Create a /docs/index.html file in this repository.
2. In the Settings tab of this repository, scroll to "GitHub Pages". Enable GitHub Pages with a source as /docs.
3. Using static web technologies, you can create documentation in this file that will be automatically served as a free web page.

Using releases

Why Releases?

Releases are GitHub's way of packaging and providing software to your users. You can think of it as a replacement to using downloads to provide software.

With Releases, you can provide links to binary files, as well as release notes describing your changes.

At their core, Releases are based on Git tags. Tags mark a specific point in the history of your project, so they're a great way to indicate a Release. Releases are ordered by a tag's date in the following way:

If it's an annotated tag, the tag object's date is used.
If it's a lightweight tag, then the commit object's date is used.

⌨️ Activity: Creating a release

1. On GitHub, navigate to the main page of the repository.

2. Under your repository name, click Releases.

3. Click Draft a new release.

4. Type a version number for your release. Versions are based on Git tags. We recommend naming tags that fit within semantic versioning.

5. Select a branch that contains the project you want to release. Usually, you'll want to release against your master branch, unless you're releasing beta software.

6. Type a title and description that describes your release.

   If you'd like to include binary files along with your release, such as compiled programs, drag and drop or select files manually in the binaries box.

   If the release is unstable, select This is a pre-release to notify users that it's not ready for production.

7. If you're ready to publicize your release, click Publish release. Otherwise, click Save draft to work on it later.

You can create releases from the GitHub user interface. Read this detailed documentation when you're ready to implement releases.

I won't respond to this issue, just close it when you are done!