Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/titaniumbones/mountains-please
repo for the mountains-please app (forked from pasta-please & pastamatic, via history-please)
https://github.com/titaniumbones/mountains-please
Last synced: 4 days ago
JSON representation
repo for the mountains-please app (forked from pasta-please & pastamatic, via history-please)
- Host: GitHub
- URL: https://github.com/titaniumbones/mountains-please
- Owner: titaniumbones
- Created: 2017-09-12T11:14:25.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2017-09-12T16:49:53.000Z (about 7 years ago)
- Last Synced: 2024-10-22T04:29:26.048Z (29 days ago)
- Language: JavaScript
- Size: 114 KB
- Stars: 0
- Watchers: 1
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# History please!
:sunrise_over_mountains::sunrise_over_mountains::sunrise_over_mountains::sunrise_over_mountains::sunrise_over_mountains::sunrise_over_mountains::sunrise_over_mountains::sunrise_over_mountains::sunrise_over_mountains:
This command line utility will return a short description of a mountain.
## Installation
First, [install node](https://nodejs.org/en/download/). Then, using the command line (terminal in Mac or Linux, Command Prompt or PowerShell in Windows), type:
```
npm install -g mountains-please
```
## Usage
You have to use the command line again:
```bash
mountain-please # Returns a mountain
--tall # Returns an 8000m mountain
--other # Returns a we little mountain
--browser # opens in the browser as well as running the command line
```
If you clone the repo on your computer (see below), you can simply run it from the repository directly instead of installing:
```bash
$ npm install
$ node bin/mountains-please.js
```
(the `$` means "command prompt" -- it's not part of the actual command).
You can also try:
```
$ npm install
$ electron .
```
in the root directory
## Contributing
First, [register with Github](https://github.com/join) and then "fork" this repository by clicking the "fork" button on the top right of this page.
Once you have an account, you can make changes to this repository directly from the Github repository web page. Add *8000-meter peaks* by clicking the `Create New File` button (top right) to add a new file to the `mountain/8000` folder:
Similarly, add *other mountains* to the `mountain/other` folder. Be sure to name the file "some-mountains-name.md" so that everyone, and also the Github server, knows it's written in Markdown. Speaking of which, you will need to use the markdown syntax:
```markdown
# Level 1 headline, for titles
## level 2 headline, for outline elements
### maybe you feel like a level 3 headline?
> quote
[link text](link URL)
*italics*
**bold**
etc.
- list item
- another list item
```
For more details, [check out the Github Markdown cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
Once you have written a description description to your satisfaction, submit a "pull request" by committing your changes and ticking the "Create a new branch for this commit and start a pull request" box.
I'll respond with comments and eventually commit the changes, and we can all enjoy them!