Update README
Add installation, usage, support, contributing, and author information.
This commit is contained in:
parent
b0006071e9
commit
a592d56547
103
README.md
103
README.md
@ -1,93 +1,40 @@
|
|||||||
# hpr_generator
|
# hpr_generator
|
||||||
|
Static web page generator for the Hacker Public Radio website.
|
||||||
Static site generator for Hacker Public Radio
|
|
||||||
|
|
||||||
|
|
||||||
## Getting started
|
|
||||||
|
|
||||||
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
|
||||||
|
|
||||||
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
|
|
||||||
|
|
||||||
## Add your files
|
|
||||||
|
|
||||||
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
|
|
||||||
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
|
|
||||||
|
|
||||||
```
|
|
||||||
cd existing_repo
|
|
||||||
git remote add origin https://gitlab.com/roan.horning/hpr_generator.git
|
|
||||||
git branch -M main
|
|
||||||
git push -uf origin main
|
|
||||||
```
|
|
||||||
|
|
||||||
## Integrate with your tools
|
|
||||||
|
|
||||||
- [ ] [Set up project integrations](https://gitlab.com/roan.horning/hpr_generator/-/settings/integrations)
|
|
||||||
|
|
||||||
## Collaborate with your team
|
|
||||||
|
|
||||||
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
|
|
||||||
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
|
|
||||||
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
|
|
||||||
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
|
|
||||||
- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
|
|
||||||
|
|
||||||
## Test and Deploy
|
|
||||||
|
|
||||||
Use the built-in continuous integration in GitLab.
|
|
||||||
|
|
||||||
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
|
|
||||||
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
|
|
||||||
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
|
|
||||||
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
|
|
||||||
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
# Editing this README
|
|
||||||
|
|
||||||
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
|
||||||
|
|
||||||
## Suggestions for a good README
|
|
||||||
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
|
||||||
|
|
||||||
## Name
|
|
||||||
Choose a self-explaining name for your project.
|
|
||||||
|
|
||||||
## Description
|
|
||||||
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
|
|
||||||
|
|
||||||
## Badges
|
|
||||||
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
|
||||||
|
|
||||||
## Visuals
|
|
||||||
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
* Clone or download this repository
|
||||||
|
* Create the sqlite3 database from the files in the _sql directory. The default name for the database file is "hpr.db" and should be located in the root of the project directory. The name and location can be set in the site.cfg file.
|
||||||
|
* Install the needed Perl modules using preferred method (distribution packages, CPAN, etc.)
|
||||||
|
* GetOpt
|
||||||
|
* Pod::Usage
|
||||||
|
* Config::Std
|
||||||
|
* Template
|
||||||
|
* DBI
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
Generate two specific pages:
|
||||||
|
`site-generator index about`
|
||||||
|
|
||||||
|
Generate the whole site:
|
||||||
|
`site-generator ALL`
|
||||||
|
|
||||||
## Support
|
## Support
|
||||||
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
Please [submit an Issue](https://gitlab.com/roan.horning/hpr_generator/-/issues),
|
||||||
|
and add the label "**Help Request**" for help running or installing the site-generator.
|
||||||
|
|
||||||
## Roadmap
|
For discussing HPR site generation in general, please [submit an Issue](https://gitlab.com/roan.horning/hpr_generator/-/issues) and add the label "**General Discussion**".
|
||||||
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
State if you are open to contributions and what your requirements are for accepting them.
|
Happy to take any contributions or suggestions.
|
||||||
|
|
||||||
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
|
To contribute code or documentation, please create a fork of the project and [submit a merge request](https://gitlab.com/roan.horning/hpr_generator/-/merge_requests) or send a patch.
|
||||||
|
|
||||||
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
|
If you have found an error in the code or the generated HTML, please [submit an Issue](https://gitlab.com/roan.horning/hpr_generator/-/issues),
|
||||||
|
and add the label "**Bug Found**".
|
||||||
|
|
||||||
|
To make a suggestion, please [submit an Issue](https://gitlab.com/roan.horning/hpr_generator/-/issues),
|
||||||
|
and add the label "**Feature Request**".
|
||||||
|
|
||||||
## Authors and acknowledgment
|
## Authors and acknowledgment
|
||||||
Show your appreciation to those who have contributed to the project.
|
* Roan "Rho`n" Horning
|
||||||
|
|
||||||
## License
|
|
||||||
For open source projects, say how it is licensed.
|
|
||||||
|
|
||||||
## Project status
|
|
||||||
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|
|
||||||
|
|||||||
@ -17,14 +17,26 @@ siteGenerator - HPR Site Generator
|
|||||||
Examples:
|
Examples:
|
||||||
|
|
||||||
Generate two specific pages:
|
Generate two specific pages:
|
||||||
siteGenerator index about
|
site-generator index about
|
||||||
|
|
||||||
Generate the whole site:
|
Generate the whole site:
|
||||||
siteGenerator ALL
|
site-generator ALL
|
||||||
|
|
||||||
=head1 DESCRIPTION
|
=head1 DESCRIPTION
|
||||||
|
|
||||||
This is a site generator based upon the Perl Templates Toolkit.
|
This is a site generator for the Hacker Public Radio website based upon the Perl Templates Toolkit.
|
||||||
|
|
||||||
|
=head1 INSTALLATION
|
||||||
|
|
||||||
|
* Create the sqlite3 database from the files in the _sql directory. The default name for the
|
||||||
|
database file is "hpr.db" and should be located in the root of the project directory. The
|
||||||
|
name and location can be set in the site.cfg file.
|
||||||
|
* Install the needed Perl modules using preferred method (distribution packages, CPAN, etc.)
|
||||||
|
* GetOpt
|
||||||
|
* Pod::Usage
|
||||||
|
* Config::Std
|
||||||
|
* Template
|
||||||
|
* DBI
|
||||||
|
|
||||||
=head1 AUTHOR
|
=head1 AUTHOR
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user