Skip to content

Commit f057b8b

Browse files
author
“Buğra
committed
Working on Readme
1 parent 1e5a9f1 commit f057b8b

2 files changed

Lines changed: 98 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
!['Logo'](https://raw.githubusercontent.com/bisguzar/st3-micropython-tools/master/images/logo2.png)
22

33
# st3-micropython-tools
4-
MicroPython board tools for Sublime Text 3. You can download, upload and remove files from/to your MicroPython board.
4+
MicroPython board tools for Sublime Text 3. You can pull, push and remove files from/to your board which installed MicroPython.
55

66
## Installation
7-
You can install **Micropython Tools** package with Package Control.
7+
88

99
## After Installation
1010
You need to change settings. Just open command palette (ctrl+shift+p) and select 'MicroPython: Settings' option. Costumize values for your project and save it. Re-open sublime text. It's done.

newREADME.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
!['Logo'](https://raw.githubusercontent.com/bisguzar/st3-micropython-tools/master/images/logo2.png)
2+
3+
# SublimeText MicroPython Tools
4+
5+
MicroPython board tools for Sublime Text 3. You can pull, push and remove files from/to your board which installed MicroPython.
6+
7+
## Getting Started
8+
9+
You need a Sublime Text (>3). And [PackageControl](http://packagecontrol.io/) if you want install plugin easily.
10+
11+
### Installing
12+
13+
You can install plugin using by PackageControl (suggested) or manually.
14+
15+
#### Install with PackageControl
16+
17+
Launch SublimeText and open command palette (`CTRL`+`SHIFT`+`P`). Type `install` and select *Package Control: Install Package* option.
18+
19+
Now you can type 'micropython'. You should see 'MicroPython Tools'. Select it and wait for installation.
20+
21+
#### Manual Installation
22+
23+
##### with git
24+
25+
You can install from github if you want, although Package Control automates
26+
just that. Go to your `Packages` subdirectory under ST2's data directory:
27+
28+
* Windows: `%APPDATA%\Sublime Text 2`
29+
* OS X: `~/Library/Application Support/Sublime Text 2`
30+
* Linux: `~/.config/sublime-text-2`
31+
* Portable Installation: `Sublime Text 2/Data`
32+
33+
Then clone this repository:
34+
35+
git clone https://github.com/bisguzar/st3-micropython-tools.git
36+
37+
##### alternative
38+
39+
[Download](https://github.com/bisguzar/st3-micropython-tools/archive/master.zip)
40+
the plugin as a zip. Copy the *st3-micropython-tools-master* directory to its location
41+
(see prior section).
42+
43+
## Running the tests
44+
45+
Explain how to run the automated tests for this system
46+
47+
### Break down into end to end tests
48+
49+
Explain what these tests test and why
50+
51+
```
52+
Give an example
53+
```
54+
55+
### And coding style tests
56+
57+
Explain what these tests test and why
58+
59+
```
60+
Give an example
61+
```
62+
63+
## Deployment
64+
65+
Add additional notes about how to deploy this on a live system
66+
67+
## Built With
68+
69+
* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
70+
* [Maven](https://maven.apache.org/) - Dependency Management
71+
* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds
72+
73+
## Contributing
74+
75+
Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
76+
77+
## Versioning
78+
79+
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
80+
81+
## Authors
82+
83+
* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth)
84+
85+
See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
86+
87+
## License
88+
89+
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
90+
91+
## Acknowledgments
92+
93+
* Hat tip to anyone whose code was used
94+
* Inspiration
95+
* etc
96+

0 commit comments

Comments
 (0)