https://github.com/iq-tech/firebolt-creator
https://github.com/iq-tech/firebolt-creator
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/iq-tech/firebolt-creator
- Owner: IQ-tech
- Created: 2022-03-21T18:56:36.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-28T22:01:56.000Z (almost 4 years ago)
- Last Synced: 2025-02-26T15:35:31.343Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://iq-tech.github.io/firebolt-creator/
- Size: 4.94 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Name of Project •
Installation •
Initial Configuration •
Features
# Name of the project
> Additional information or tagline
A brief description of your project, what it is used for and how does life get
awesome when someone starts to use it.
## Installing / Getting started
A quick introduction of the minimal setup you need to get a hello world up &
running.
```shell
packagemanager install awesome-project
awesome-project start
awesome-project "Do something!" # prints "Nah."
```
Here you should say what actually happens when you execute the code above.
📚 Show more code examples
### Another example
In case your project has a lot of examples, you can use this toggle list to prevent your README for being too long.
Here you can put all secondary examples that can help the users of your project.
```
your code here
```
### Initial Configuration
Some projects require initial configuration (e.g. access tokens or keys, `npm i`).
This is the section where you would document those requirements.
## Developing
Here's a brief intro about what a developer must do in order to start developing
the project further:
```shell
git clone https://github.com/your/awesome-project.git
cd awesome-project/
packagemanager install
```
And state what happens step-by-step.
### Building
If your project needs some additional steps for the developer to build the
project after some code changes, state them here:
```shell
./configure
make
make install
```
Here again you should state what actually happens when the code above gets
executed.
### Deploying / Publishing
In case there's some step you have to take that publishes this project to a
server, this is the right time to state it.
```shell
packagemanager deploy awesome-project -s server.com -u username -p password
```
And again you'd need to tell what the previous code actually does.
## Features
What's all the bells and whistles this project can perform?
* What's the main functionality
* You can also do another thing
* If you get really randy, you can even do this
In case you find useful for your project, you can also add a comparative table, as follow:
| | Project A | Project B |
| -------------------------- | :--------: | :-------: |
| Feature A | ✔️ | ❌ |
| Feature B | ✔️ | ❌ |
## Contributing
When you publish something open source, one of the greatest motivations is that
anyone can just jump in and start contributing to your project.
These paragraphs are meant to welcome those kind souls to feel that they are
needed. You should state something like:
"If you'd like to contribute, please fork the repository and use a feature
branch. Pull requests are warmly welcome."
If there's anything else the developer needs to know (e.g. the code style
guide), you should link it here. If there's a lot of things to take into
consideration, it is common to separate this section to its own file called
`CONTRIBUTING.md` (or similar). If so, you should say that it exists here.
## Links
Even though this information can be found inside the project on machine-readable
format like in a .json file, it's good to include a summary of most useful
links to humans using your project. You can include links like:
- Project homepage: https://your.github.com/awesome-project/
- Repository: https://github.com/your/awesome-project/
- Issue tracker: https://github.com/your/awesome-project/issues
- In case of sensitive bugs like security vulnerabilities, please contact
my@email.com directly instead of using issue tracker. We value your effort
to improve the security and privacy of this project!
- Related projects:
- Your other project: https://github.com/your/other-project/
- Someone else's project: https://github.com/someones/awesome-project/