https://github.com/j2team/autoit-docset-generator
AutoIt and Python script to generate AutoIt Docset for Dash, Zeal and Velocity.
https://github.com/j2team/autoit-docset-generator
Last synced: 4 months ago
JSON representation
AutoIt and Python script to generate AutoIt Docset for Dash, Zeal and Velocity.
- Host: GitHub
- URL: https://github.com/j2team/autoit-docset-generator
- Owner: J2TEAM
- License: mit
- Created: 2015-06-26T12:24:08.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2015-07-21T04:08:05.000Z (about 11 years ago)
- Last Synced: 2025-02-04T13:44:28.725Z (over 1 year ago)
- Language: AutoIt
- Homepage: http://junookyo.blogspot.com/
- Size: 12.7 MB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AutoIt Docset Generator
AutoIt and Python script to generate AutoIt Docset for Dash, Zeal and Velocity.
## Author
- Mạnh Tuấn (a.k.a Juno_okyo)
+ Twitter: [@juno_okyo](https://twitter.com/juno_okyo)
+ GitHub: [J2TeaM](https://github.com/J2TeaM)
## Usage (step-by-step to generate the docset)
- Download [this script](https://github.com/J2TeaM/AutoIt-Docset-Generator/archive/master.zip) and extract to somewhere you want.
* AutoIt version
- Make sure you have installed [AutoIt](https://www.autoitscript.com/site/autoit/downloads/).
- Right-click on the file **AutoIt Docset Generator.au3** and select **Edit Script**.
- Press **F5** and check **SciTE console** for debug info.
- A folder named **AutoIt.docset** will be created in the same directory.
* Python version
- Make sure you have installed [Python](https://www.python.org/) (2.x).
- Run **AutoIt Docset Generator.py** with IDLE or Command-Prompt (if you want).
- A folder named **AutoIt.docset** will be created in the same directory.
## References
This script was written with reference informations:
- [Docset Generation Guide](https://kapeli.com/docsets#dashDocset)
- [Dash User Contributed Docsets](https://github.com/Kapeli/Dash-User-Contributions#dash-user-contributed-docsets)
- [Decompile CHM files](https://msdn.microsoft.com/en-us/library/windows/desktop/ms524370(v=vs.85).aspx)
## Contributing
1. Fork it!
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. Submit a pull request :+1:
## Credits
- **AutoIt Team** (original CHM document)
- **Juno_okyo**
## License
The MIT License (MIT)
Copyright (c) 2015 Juno_okyo
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.