diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..eed55459cb4448aa0da487acd280f470f5958e94 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2016-2017 Dmytro Bogatov + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 71b5d8c6544564c7a69838e5905ad67d84f4b153..af4d31feae775461a90665352e28758faf413d1a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,47 @@ # TL-Verilog support for Atom -TL-Verilog support. + + +## Features + +### Done + +- Syntax highlighting for `.tlv` `.TLV` files + +### Known bugs + +- None so far +- Open the issue in one of the repos + +## Git repos + +- Personal, main: [dbogatov/TL-Verilog-Atom](https://git.dbogatov.org/dbogatov/TL-Verilog-Atom) +- GitHub, mirror: [dbogatov/tlv-atom](https://github.com/dbogatov/tlv-atom) + +## Repository organization + +This repository is organized as follows: + +``` +grammars/ syntax definition +styles/ theme definitions +static/ static assets for README +package.json package configuration +LICENSE.txt license +README.md readme +``` + +## Contributing +1. Fork it ( [dbogatov/tlv-atom](https://github.com/dbogatov/tlv-atom) ) +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Commit your changes (`git commit -am 'Add some feature'`) +4. Push to the branch (`git push origin my-new-feature`) +5. Create a new Pull Request + +## See also + +[TL-Verilog](https://atom.io/packages/tl-verilog) + +## License + +[MIT](LICENSE) diff --git a/package.json b/package.json index 4b7e95dc334776b1a92dee0768bbd9db0e1d9a77..53a234141e6f7666cd59831a0db27694df17a67c 100644 --- a/package.json +++ b/package.json @@ -1,12 +1,20 @@ { - "name": "tl-verilog", - "version": "0.1.0", - "description": "TL-Verilog support", - "keywords": [], - "repository": "https://github.com/dbogatov/tlv-atom", - "license": "MIT", - "engines": { - "atom": ">=1.0.0 <2.0.0" - }, - "dependencies": {} -} + "name": "tl-verilog", + "author": "Dmytro Bogatov <dmytro@dbogatov.org>", + "version": "0.2.0", + "description": "TL-Verilog support", + "keywords": [ + "tlv", + "tl verilog", + "tl-verilog", + "verilog", + "grammar", + "syntax" + ], + "repository": "https://github.com/dbogatov/tlv-atom", + "license": "MIT", + "engines": { + "atom": ">=1.0.0 <2.0.0" + }, + "dependencies": {} +} \ No newline at end of file diff --git a/static/screenshot.png b/static/screenshot.png new file mode 100644 index 0000000000000000000000000000000000000000..4875bf73dacd00ee4b99ff6c4b78768d7d8d400d Binary files /dev/null and b/static/screenshot.png differ