https://github.com/njh/arduino-libraries

A website listing all the available Arduino Libraries
https://github.com/njh/arduino-libraries

arduino

Last synced: 3 months ago
JSON representation

A website listing all the available Arduino Libraries

• Host: GitHub
• URL: https://github.com/njh/arduino-libraries
• Owner: njh
• License: mit
• Created: 2016-08-01T15:34:03.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2024-02-03T16:46:49.000Z (11 months ago)
• Last Synced: 2024-10-15T16:19:33.837Z (3 months ago)
• Topics: arduino
• Language: Ruby
• Homepage: https://www.arduinolibraries.info/
• Size: 148 KB
• Stars: 54
• Watchers: 9
• Forks: 12
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
Arduino Library List

====================

This is the code repository that generates the [arduinolibraries.info] website.

It is a statically generated website.

The steps to generate the site are:

1. Download the ```library_index.json``` file from arduino.cc.

2. Convert the JSON file into indexes that make it easy to generate the site

3. Generate the HTML files for the homepage and each of the sections

4. Generate a sitemap listing all the files that were generated

5. Upload the files to the web server

## Development

The scripts that generate the website are written in [Ruby]. You may need to install a recent version of ruby of my computer before you can run the scripts.

First make sure you have [Bundler] installed:

    $ gem install bundler

Then install all the dependencies:

    $ bundle install

To build a copy of the website on your local machine run:

    $ rake build

This will download the required data, and generate all the HTML files.

You can then run a web-server locally on your machine to view the site:

    $ rake server

And then open the following URL in your browser: [http://localhost:3000/]

The files that define what the pages look like are in the `views` folder.

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/njh/arduino-libraries. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License].

[arduinolibraries.info]:     https://arduinolibraries.info/

[MIT License]:               http://opensource.org/licenses/MIT

[Ruby]:                      https://www.ruby-lang.org/

[Bundler]:                   http://bundler.io/

[http://localhost:3000/]:    http://localhost:3000/