Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add package.json and update README #48

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,26 @@ AccesSlide
A HTML5-CSS3-JS framework for accessible keynotes.
[Version française](READMEFR.md)

# Install

Install grunt globally with npm.

```npm
npm install -g grunt
```

Go to your folder where you want to install the project and launch the installation.

```npm
npm install
```

Run the project

```npm
grunt
```

# Structure
Put the slides in the `main` element with `section` elements associated with a `slide` class.
`section` elements can be imbricated in `section` elements.
Expand Down Expand Up @@ -156,4 +176,4 @@ To use a language file, edit the file path in the `head` of the page. Here is an
* Edit the buttons labels `label`, image alternatives `alt`, options values `value` of the effects list, buttons or windows titles `title` and help messages `help`
* Save your language file using the filename `lang_[language code].js`

Check out the live demo: www.accesslide.net
Check out the live demo: www.accesslide.net
22 changes: 21 additions & 1 deletion READMEFR.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,26 @@ AccesSlide

Un framework pour réaliser des présentations accessibles en HTML5-CSS3-JS.

# Installation

Installez grunt globalement avec npm.

```npm
npm install -g grunt
```

Rendez-vous dans votre dossier où vous souhaitez installer le projet et lancez l'installation.

```npm
npm install
```

Lancer le projet

```npm
grunt
```

# Structure

Les diapos s'insèrent dans l'élément `main` avec des éléments `section` associés à une classe `slide`.
Expand Down Expand Up @@ -148,4 +168,4 @@ Pour utiliser un fichier de langue, modifiez la référence au fichier dans le `
- Modifiez les étiquettes `label` des boutons, les alternatives `alt` d'images, les intitulés `value` des options de la liste des effets, les titres `title` de boutons ou de fenêtres et les messages help d'aide.
- Enregistrez votre fichier de langue en utilisant le nom de fichier `lang_[code de langue].js`.

Une démonstration est visible sur le site dédié : www.accesslide.net
Une démonstration est visible sur le site dédié : www.accesslide.net
Loading