readium / architecture

📚 Documents the architecture of the Readium projects

BSD 3-Clause "New" or "Revised" License

176 stars 33 forks source link

Naming of the new web-based Reader repos #75

Open rkwright opened 6 years ago

rkwright commented 6 years ago

@rkwright wrote document about the EOL of the Chrome app here. As part of that it was proposed that the naming of the new repos be as follows:

New Repos

We will need four new repos corresponding to readium-js, readium-js-viewer, shared-js and cfi-js. One approach would be to pattern them of the existing names and the "r2" prefix used elsewhere. Thus:

R1 Name	Readium-Web Name
readium-js-viewer	r2-js-viewer
readium-js	r2-js
readium-shared-js	r2-shared-js
readium-cfi-js	r2-cfi-js

Each of these repos will be a clone of the existing repo, then modified by

removing all code, build-scripts, resources, etc. related to the Chrome app
adding new interfaces and APIs as appropriate
modifying and/or adding tests in order to enable functional testing (e.g. continuous build processes such as on Travis)

rkwright commented 6 years ago

@JCCR wrote: I'm looking at adopting new names for the "evolved" readium-js repos I've been working on.

If we are going by what's in your EOL doc.. I see a problem (https://github.com/readium/readium-js-viewer/wiki/EOL-for-ReadiumJS-and-BOL-for-Readium-Web#new-repos)

The shared code for the JS R2 streamer/navigator is called r2-shared-js already.

I propose we either rename the previous projects with some sort of -archived suffix readium-js-archived readium-js-viewer-archived

Rename it to something else: readium-js-old readium-js-legacy

Or use a different naming convention for the new packages: I'm currently in favour of a mono repo called r2-js-classic

rkwright commented 6 years ago

Clearly, these new repos need to be named as a function of the outcome of the discussion in this thread.

jccr commented 6 years ago

Readium Web Repositories

r2-testapp-web

Demo viewer application to showcase capabilities.
Simple UI, nothing fancy.
Can be built on its own with r2-* projects published and pulled from npm.

r2-navigator-web

What's going to be formed from Readium NG
Can be built on its to just run the test suite.

r2-workspace-web

Bootstrap a Readium web developer's workspace.
Builds the r2-testapp-web with local versions of r2-* projects:
- r2-navigator-web
- r2-shared-js
- r2-utils-js
- r2-glue-js