chattheatre / eos Goto Github PK

Installation instructions link in README.md 404s.

Documentation Related Requests and Decisions for @noahgibbs

• Contract, Copyright and License Related
  • Re-sign Cycle 2020-E work order
  • Add CC0 declaration to
    • https://github.com/ChatTheatre/eOS-Doc/blob/master/README.md
    • https://github.com/ChatTheatre/SkotOS-Doc/blob/master/README.md
    • https://github.com/ChatTheatre/kernellib-doc/blob/master/README.md
    • https://github.com/ChatTheatre/kernellib-doc/blob/master/README.md
    • https://github.com/ChatTheatre/lpc-doc/blob/master/README.md
  • Add CLA.md and ./CLA-signed/cla*.asc (and AGPL LICENSE from file if needed)
    • https://github.com/ChatTheatre/SkotOS/
    • https://github.com/ChatTheatre/eOS/
    • https://github.com/ChatTheatre/thin-auth
    • https://github.com/ChatTheatre/orchil
    • https://github.com/ChatTheatre/websocket-to-tcp-tunnel

Note that with all of the following I've create github webpage for, so after edit pass confirm that the webpages look correct.

• Delete your repo and test install instructions for https://github.com/ChatTheatre/eOS/ and update README.md accordingly

• Document what each of the folders are, and what for, in https://github.com/ChatTheatre/eOS/blob/master/README.md

• Review docs at bottom of https://github.com/ChatTheatre/kernellib/blob/master/README.md and edit/move docs as appropriate to https://github.com/ChatTheatre/kernellib-doc/ instead.

  • In https://github.com/ChatTheatre/kernellib-doc/ add TOC to README.md and one-two line abstract for each doc moved there.
  • Set up framework for same TOC style in other -Docs repo README.md

• Edit/Merge to eOS-doc, name appropriately (eOS-architecture?) and delete originals (if not in SkotOS they may have been moved to SkotOS-Docs)

  • https://github.com/ChatTheatre/SkotOS/blob/master/docs/layers.md
  • https://github.com/ChatTheatre/SkotOS/blob/master/docs/dgd/layers.md

• Choose and document an initial strategy for how we want to add examples to /usr

  • Should we create empty ./usr/ folder in eOS repo?
  • Should there be one or more examples that are under eOS repo control?
  • What is MVP vs a mimimal plugin strategy.
  • Or do we tell people to fork examples /usr/ into their github folders, submodule them in their personal repos, and then we have .gitignore for /usr/* in the eOS repo so that they don't get picked up?
  • Or do we tell people to wget or rsync -rlp --exclude '.git' user@host:path/to/git/repo/ . contents of a example repo, such as Nino's example, and tell them to git init it to their personal github accounts?

• Create a prioritized list of legacy DGD / LPC / kernellib and other documents to convert/update for eOS, and list them in a eOS markdown file with pointer to source file.

We definitely want eOS to use by default the Orchil client, but its unclear to me if it should be a submodule in this repo. I also presume that Orchil can't be served by DGD and must be served by the websocket-to-tcp tunnel node.js service.

It is likely that eOS doesn't need the full thin-auth, but it is pretty darn close to an MVP of what a chat theatre or a small game needs. Otherwise user admin has to be done in different ways. But don't know.

@noahgibbs What are your thoughts?