Skip to content

Latest commit

 

History

History
46 lines (36 loc) · 3.01 KB

README.md

File metadata and controls

46 lines (36 loc) · 3.01 KB

CBL-ReadingLists

Started off as the Marvel Master Reading Order + Others but has rapidly changed into support for all facets of reading lists.

These lists are not created by me. Credit goes to the orginal authors. I'm just curating them into a single place to hopefully make it easier for people to find what they want to read.

Discord

We now have a discord server to help cordinate changes and discuss things in an open and public place. Join us!

https://discord.gg/DQmHfzFdGG

About This Project

  • The main intention of this project is to create an organised source of reading lists for use with comic readers/management software
  • All reading lists are provided in CBL format, with book data verified on ComicVine
  • The data used to create these reading lists is based on CBRO, CMRO and other reading-list management tools. The intention of this project is not to create an alternative to these tools, but to make the information in these tools usable in comic reading/management software.

Additional Resources

There are a number of websites that host reading lists in a visual display (no CBL files available). These include the following:

Contributing

We are looking for people who want to assist in the efforts to make the best reading lists possible. Different ways to help include:

Contributing code (Pull Requests)

  • Only make pull requests against the untrusted branch - never main! For the time being we are doing pulls against main. This might change in the future.
  • Please explain your logic when submitting each PR. You're probably going to get some comments or questions from us, to ensure consistency and maintainability.
  • Each PR should come with a meaningful name (what is being added/fixed)
  • Make meaningful commits, squash them if necessary
  • Try to keep it to one feature/fix per pull request to keep things clean and easy to understand

Suggesting improvements or changes

  • If you have any constructive feedback on the data structure, how reading lists are handled, or issues within the reading-lists themselves, please create an issue on Github which clearly explains your thoughts, or join our discord to talk it over.

Creating tools

  • If you have programming abilities there is always some small script that could be useful. Join the discord and ask in the #tools channel.