search

tundish / balladeer

Screenplay dialogue, Interactive Fiction and multimedia Games. A Python package for the Web.
GNU General Public License v3.0
8 stars 1 forks source link

Better initialization instructions in the user documentation #2

Open danieltalsky opened 3 months ago

danieltalsky commented 3 months ago

The user documentation doesn't provide the basic steps to start a new project of your own using balladeer: https://balladeer.readthedocs.io/en/latest/intro.html

The repo documentation does, of course, but one must switch between the two. A small "installation and initialization" section would make the process less opaque for someone trying to initialize their balladeer project and be a good segue into a little bit more example-based documentation.

danieltalsky commented 3 months ago

In addition: other than the examples there is NO documentation about what files need to be created. The examples are decent but there's no documentation about when a Scene toml file, CSS file, or any other file need to be created.

tundish commented 2 months ago

Hi Daniel, thanks for taking the time to explore. Your feedback is really valuable. Sorry for my delay in replying.

I am still in the process of discovering what a newly-initialized Balladeer project should look like. I am working by degrees to realize a framework which allows an author to start small but scale up without too many growing pains.

I'm also not sure yet how much it's reasonable to expect an author to create that framework by hand, or if some automation is necessary. So I've started a side project called Busker. This will eventually serve as a platform for project management, testing, packaging, etc. Very early days at the moment.