Skip to content

Commit 563243e

Browse files
authored
Merge pull request #193 from readium/admin-updates
Admin updates: - update ReadMe, contributing doc, and templates. - Build process has also been updated to list contributors in the header of dist stylesheets.
2 parents aa73c5c + 17bff43 commit 563243e

21 files changed

+280
-386
lines changed
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Bug report
2+
description: File a bug report to help improve Readium CSS
3+
labels: []
4+
type: "Bug"
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for filing a bug report! Please [search for existing issues](https://github.com/readium/css/issues?q=is:issue) before submitting.
10+
- type: textarea
11+
id: bug-description
12+
attributes:
13+
label: Describe the bug
14+
description: Also, please let us know what your expectations were.
15+
placeholder: A clear and concise description of what the bug is.
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: bug-steps
20+
attributes:
21+
label: How to reproduce?
22+
description: |
23+
Step by step explanation to reproduce the issue in the Test App.
24+
25+
If you can, drag and drop:
26+
- the publication used to reproduce the problem, after zipping it.
27+
- screenshots or a screencast showing the issue
28+
29+
placeholder: |
30+
1. Open book X
31+
2. Go to chapter Y
32+
3. Swipe left twice
33+
4. See error
34+
...
35+
validations:
36+
required: true
37+
- type: input
38+
id: bug-readium-css-version
39+
attributes:
40+
label: Readium CSS version
41+
description: What version of Readium CSS are you running?
42+
validations:
43+
required: true
44+
- type: input
45+
id: bug-platforms
46+
attributes:
47+
label: Platforms
48+
description: On which platform(s) did you reproduce the problem?
49+
validations:
50+
required: true
51+
- type: input
52+
id: bug-browsers
53+
attributes:
54+
label: Browsers
55+
description: On which browser(s) did you reproduce the problem?
56+
validations:
57+
required: true
58+
- type: textarea
59+
id: bug-additional
60+
attributes:
61+
label: Additional context
62+
description: |
63+
Share additional code showing how you use Readium, if relevant. Output logs are useful as well.
64+
If you already went through the codebase to find the bug, you can explain your findings here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true

.github/issue_template.md

Lines changed: 0 additions & 38 deletions
This file was deleted.

.github/pull_request_template.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

.github/workflows/node.js.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ jobs:
2020
- uses: actions/checkout@v4
2121
with:
2222
ref: ${{ github.head_ref }}
23+
fetch-depth: 0 # Fetch complete git history
2324
- name: Use Node.js
2425
uses: actions/setup-node@v4
2526
with:

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,14 @@
22

33
[![Readium Logo](https://readium.org/assets/logos/readium-logo.png)](https://readium.org)
44

5-
A set of reference stylesheets for EPUB Reading Systems, starting with Readium 2.
5+
A set of reference stylesheets for EPUB Reading Systems.
66

77
Readium CSS provides styles for reflowable text:
88

99
- paged and scrolled views;
1010
- a “patch” for HTML5 Suggested Rendering specific to publications (e.g. extra styles for hyphenation, breaks, etc.);
1111
- default styles for unstyled ebooks;
12-
- reading modes (night and sepia);
13-
- themes;
12+
- theming;
1413
- user settings;
1514
- a set of baselines and recommendations for accessibility, overrides, and internationalization.
1615

@@ -24,29 +23,30 @@ See [license.txt](https://github.com/readium/css/blob/master/LICENSE).
2423

2524
The primary goal of Readium CSS is to provide Reading System implementers with reliable and modern styles for reflowable EPUB 2 and EPUB 3 files. In addition, it should provide good interoperability in the existing ecosystem, while not overriding authors’ styles unless strictly necessary.
2625

27-
Readium CSS stylesheets were not designed and should not be used for fixed-layout EPUB, nor other file formats like FB2, PRC, Mobi, TEI, etc. Works in progress like Web Publications or Portable Web Publications are also out of scope.
26+
Readium CSS stylesheets were not designed and should not be used for fixed-layout EPUB, nor other file formats like FB2, PRC, Mobi, TEI, etc.
2827

2928
Some issues, which may be raised during development, will be documented so that they can serve as a reference for revisions of the EPUB specification, and even future specifications.
3029

31-
## Testing
30+
## Implementations
3231

33-
An [iOS test app](https://github.com/readium/r2-testapp-swift) for the Swift implementation of Readium 2 is using Readium CSS and can be [downloaded on the App Store](https://itunes.apple.com/us/app/r2-reader/id1363963230?mt=8).
32+
Readium CSS is implemented in the [Readium Mobile](https://github.com/readium/mobile) and [Readium Web](https://github.com/readium/web) projects.
3433

35-
An [Android test app](https://github.com/readium/r2-testapp-kotlin) for the Kotlin implementation of Readium 2 is using Readium CSS. Stable builds are [available on Google Play](https://play.google.com/store/apps/details?id=org.readium.r2reader). To follow the development of this app, [join the beta channel](https://play.google.com/apps/testing/org.readium.r2reader).
34+
You will find it in:
3635

37-
The Readium Desktop app is using Readium CSS and [is available for Linux, MacOS and Windows](https://github.com/edrlab/readium-desktop/releases).
36+
- [ts-toolkit](https://github.com/readium/ts-toolkit)
37+
- [swift-toolkit](https://github.com/readium/swift-toolkit)
38+
- [kotlin-toolkit](https://github.com/readium/kotlin-toolkit)
3839

39-
You can also use the [webpub manifest prototype](https://github.com/HadrienGardeur/webpub-manifest/tree/gh-pages/examples/paged-viewer) with the [RS-streamer-js](https://github.com/edrlab/r2-streamer-js) in a local development environment. Please note you’ll have to manually inject stylesheets and apply settings via the console, or design and code scripts if you want a GUI (user settings menu).
40+
External use include:
4041

41-
## Other known implementations
42-
43-
There is no external implementation of Readium CSS so far.
44-
45-
Consequently, if you are encountering rendering issues with Readium (iOS apps, Android apps, or the Readium Chrome App), please report them on the [github section dedicated to the proper Readium project](https://github.com/readium) (readium-js, readium-shared-js, readium-sdk, etc.).
42+
- [Thorium Desktop](https://github.com/edrlab/thorium-reader)
43+
- [Thorium Web](https://github.com/edrlab/thorium-web)
44+
- [Zotero](https://github.com/zotero/reader)
45+
- [Vital Source](https://www.vitalsource.com/)
4646

4747
## Development
4848

49-
Active development is pulled in branch `develop` first, and then made available in the main branch when sufficiently tested and deemed stable.
49+
Active development is pulled in branch `develop`.
5050

5151
### Init
5252

0 commit comments

Comments
 (0)