Skip to content

Commit 90d67ee

Browse files
committed
readme.md: update
1 parent d55dbc0 commit 90d67ee

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,35 @@ This is a test of creating an Atom package, it provides no tools for helping peo
33

44
![Screenshot](./resources/images/screenshot.png)
55

6+
## Installation
7+
8+
1. Open your terminal
9+
- Windows: Press <kbd>Ctrl</kbd> + <kbd>R</kbd>, enter `cmd` (or `powershell`).
10+
- Mac OS X: Press <kbd>Cmd</kbd> + <kbd>Space</kbd>.
11+
- Linux: Press <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>T</kbd>.
12+
13+
2. Install this package to your Atom
14+
- In your terminal, enter this command:
15+
```bash
16+
apm install https://github.com/ksxatompackages/atom-prime-generator.git
17+
```
18+
- You need to restart your Atom to use this package.
19+
20+
## User Manual
21+
22+
### Open/Close Prime Generator panel
23+
After you open/restart your Atom, there're 2 ways to toggle the panel:
24+
1. In menu-bar, go to Packages &#x2192; prime-generator &#x2192; Toggle.
25+
2. Open Command Palettle (by pressing <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>), then enter `Prime Generator: Toggle`.
26+
27+
### User Interface
28+
- Input box: Representing amount of primes would be printed.
29+
- Hit <kbd>Enter</kbd> to print prime numbers.
30+
- Hit <kbd>ESC</kbd> to clear reset (if the box was not empty) or close the panel (if the box was empty).
31+
- Buttons
32+
- Add: Print more an amount of primes which was represented by value in the input box.
33+
- Reset: Clear the input box, reset output.
34+
635
# Prime Number Definition
736

837
## Common definition
@@ -26,12 +55,14 @@ This is a test of creating an Atom package, it provides no tools for helping peo
2655
## Usage of `PrimeGenerator`
2756

2857
### Getting class
58+
2959
#### Installation
3060
Open your terminal, type:
3161
```bash
3262
cd path/to/node_modules
3363
npm install https://github.com/ksxnodemodules/ksxnodemodules.git
3464
```
65+
3566
#### Importation in JavaScript
3667
```javascript
3768
var PrimeGenerator = require('ksxnodemodules').prime.PrimeGenerator;

0 commit comments

Comments
 (0)