Archives/asciinema.org
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Always use lowercase "asciinema". Also fix git repositories' URLs

Browse Source
This commit is contained in:
Marcin Kulik 2014-12-17 15:46:03 +00:00
parent e5f307cbbc
commit a7aab637fe
8 changed files with 48 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -6,12 +6,12 @@
Record and share your terminal sessions, the right way.
Asciinema is a free and open source solution for recording the terminal
sessions and sharing them on the web.
asciinema is a free and open source solution for recording terminal sessions
and sharing them on the web.
This is the source code of asciinema.org (formerly ascii.io) website and JS
player. If you're looking for asciinema terminal recorder go here:
[sickill/asciinema](https://github.com/sickill/asciinema)
This is the source code of asciinema.org (formerly ascii.io) website. If you're
looking for asciinema's terminal recorder go here:
[asciinema/asciinema-cli](https://github.com/asciinema/asciinema-cli)
## Setup instructions
@ -41,7 +41,7 @@ dependencies installed:
Clone git repository:
```bash
$ git clone git://github.com/sickill/asciinema.org.git
$ git clone git://github.com/asciinema/asciinema.org.git
$ cd asciinema.org
```
@ -84,7 +84,7 @@ If you want to contribute to this project check out
## Authors
Developed with passion by [Marcin Kulik](http://ku1ik.com) and great open
source [contributors](https://github.com/sickill/asciinema.org/contributors)
source [contributors](https://github.com/asciinema/asciinema.org/contributors)
## Copyright

2
app/controllers/sessions_controller.rb
View File

@ -32,7 +32,7 @@ class SessionsController < ApplicationController
def login_notice(user)
if user.first_login?
"Welcome to Asciinema!"
"Welcome to asciinema!"
else
"Welcome back!"
end

4
app/helpers/application_helper.rb
View File

@ -19,9 +19,9 @@ module ApplicationHelper
def page_title
if content_for?(:title)
"#{content_for(:title)} - Asciinema".html_safe
"#{content_for(:title)} - asciinema".html_safe
else
"Asciinema - Record and share your terminal sessions, the right way"
"asciinema - Record and share your terminal sessions, the right way"
end
end

19
app/views/docs/how-it-works.html.slim
View File

@ -4,10 +4,11 @@ markdown:
# How it works
Asciinema project is built of 2 complementary pieces:
asciinema project is built of several complementary pieces:
* a command-line based terminal session recorder, `asciinema`,
* a website with an API and a player at asciinema.org
* command-line based terminal session recorder, `asciinema`,
* website with an API at asciinema.org,
* javascript player
When you run `asciinema rec` in your terminal the recording starts, capturing
all output that is being printed to your terminal while you're issuing the
@ -15,11 +16,11 @@ markdown:
typing `exit`) then the captured output is uploaded to asciinema.org website
and prepared for playback on the web.
Here's a brief overview of how both these parts work.
Here's a brief overview of how these parts work.
## Recording
You probably know `ssh`, `screen` or `script` command. Actually, Asciinema
You probably know `ssh`, `screen` or `script` command. Actually, asciinema
was inspired by `script` (and `scriptreplay`) commands. What you may not know
is they all use the same UNIX system capability: [a
pseudo-terminal](http://en.wikipedia.org/wiki/Pseudo_terminal).
@ -42,7 +43,7 @@ markdown:
<kbd>Ctrl-A</kbd> and altering the output in order to display window
numbers/names and other messages.
Asciinema recorder does its job by utilizing pseudo-terminal for capturing
asciinema recorder does its job by utilizing pseudo-terminal for capturing
all the output that goes to a terminal and saving it in memory (together with
timing information). The captured output includes all the text and invisible
escape/control sequences in a raw, unaltered form. When the recording session
@ -50,7 +51,7 @@ markdown:
part.
For the implementation details check out [recorder source
code](https://github.com/sickill/asciinema).
code](https://github.com/asciinema/asciinema-cli).
## Playback
@ -62,7 +63,7 @@ markdown:
correctly display color changes, cursor movement and printing text at proper
places on the screen.
Escape sequence interpretation was initially handled by Asciinema's own VT100
Escape sequence interpretation was initially handled by asciinema's own VT100
terminal emulation layer written in Javascript but was later replaced with
[libtsm](http://www.freedesktop.org/wiki/Software/kmscon/libtsm/) based
interpreter. libtsm, "terminal-emulator state machine", is a wonderful, rock
@ -79,4 +80,4 @@ markdown:
underline, inverse, ...) and 256 colors perfectly rendered.
For the implementation details check out [asciinema.org source
code](https://github.com/sickill/asciinema.org).
code](https://github.com/asciinema/asciinema.org).

2
app/views/home/show.html.slim
View File

@ -24,7 +24,7 @@
.row.about
.col-md-12
h3
' Asciinema is a free and open source solution for recording the
' asciinema is a free and open source solution for recording the
terminal sessions and sharing them on the web. Read more about
a href=docs_path('how-it-works') how it works
' .

2
app/views/logins/new.html.slim
View File

@ -5,7 +5,7 @@
br
p Log in to Asciinema using your email address:
p Log in to asciinema.org using your email address:
= form_tag login_path, class: "form-inline login-form" do
.form-group

30
app/views/pages/about.html.slim
View File

@ -1,21 +1,22 @@
- content_for(:title, 'About Asciinema')
- content_for(:title, 'About asciinema')
.row.about
.col-md-8
markdown:
# About Asciinema
# About asciinema
Asciinema (formerly ascii.io) is a free and open source solution for
recording the terminal sessions and sharing them on the web.
asciinema (formerly ascii.io) is a free and open source solution for
recording terminal sessions and sharing them on the web.
It aims to be a "go to" place for every command-line user who wants to share
his skills with others. Or putting it differently, it's a place to show off
your geekiness.
The Asciinema project is built of 2 sub-projects:
asciinema project is built of several sub-projects:
* a command-line based terminal session recorder, `asciinema` ([source code](https://github.com/sickill/asciinema)),
* a website with an API and a player at asciinema.org ([source code](https://github.com/sickill/asciinema.org))
* command-line based terminal session recorder, `asciinema` ([source code](https://github.com/asciinema/asciinema-cli))
* asciinema.org - a website with an API ([source code](https://github.com/asciinema/asciinema.org))
* javascript player ([source code](https://github.com/asciinema/asciinema-player))
If technical details interest you then read more about
[how it works](#{docs_path('how-it-works')}).
@ -26,22 +27,23 @@
## A bit of a history
Asciinema project was started by <a href="/~sickill">Marcin Kulik</a>
asciinema project was started by <a href="/~sickill">Marcin Kulik</a>
([@sickill](https://twitter.com/sickill)) in the beginning of 2011 as
ascii.io. He was playing with the idea of sharing terminal session
recordings on the web since 2010 but the working prototype came to life a bit
later. asciinema.org site had a first public release in March 2012 (as
ascii.io then). The project was renamed to Asciinema in September 2013.
ascii.io then). The project was renamed to "asciinema" in September 2013.
Asciinema is actively developed with the help of great open
source [contributors](https://github.com/sickill/asciinema.org/contributors).
asciinema is actively developed with the help of great open
source [contributors](https://github.com/asciinema/asciinema.org/contributors).
## Reporting bugs
As the service is built of 2 parts there are 2 separate bug trackers:
As the service is built of several parts there are separate bug trackers:
* [github.com/sickill/asciinema.org/issues](https://github.com/sickill/asciinema.org/issues) - for the website / player / embedding issues and ideas,
* [github.com/sickill/asciinema/issues](https://github.com/sickill/asciinema/issues) - for the recorder issues and ideas.
* [github.com/asciinema/asciinema-cli/issues](https://github.com/asciinema/asciinema-cli/issues) - for recorder issues and ideas
* [github.com/asciinema/asciinema.org/issues](https://github.com/asciinema/asciinema.org/issues) - for website/embedding issues and ideas
* [github.com/asciinema/asciinema-player/issues](https://github.com/asciinema/asciinema-player/issues) - for player issues and ideas
Please only use them for reporting bugs and submitting feature requests.
Do not ask for general help there. Use IRC or the support email for that.

25
app/views/pages/contributing.html.slim
View File

@ -1,11 +1,11 @@
- content_for(:title, 'Contributing to Asciinema')
- content_for(:title, 'Contributing to asciinema')
.row.about
.col-md-8
h1 Contributing to the project
p
' Asciinema is open-source software and the service at asciinema.org is
' asciinema is open-source software and the service at asciinema.org is
made available free of charge to anyone. A lot of effort is put in this
project and it's developed exclusively in free time. If you find the
service useful, you think it's a great idea or you believe in giving
@ -15,7 +15,7 @@
p
' Supporting an open-source project feels great. And you can do it in
many ways. Here is a list of a few things you can do to show your
appreciation and help Asciinema.
appreciation and help asciinema.
h2 id="donating" Donating
@ -31,7 +31,7 @@
motivates future developments.
p
' You can choose from several options below to support Asciinema financially.
' You can choose from several options below to support asciinema financially.
h3 Bitcoin
@ -43,21 +43,21 @@
p
= image_tag 'bitcoin-logo.png', class: 'bitcoin-logo'
a href="bitcoin:1GLaEx3cU5rzaMVhst1djCJvs5HK8PAsV4?amount=0.05&label=Asciinema%20donation" 1GLaEx3cU5rzaMVhst1djCJvs5HK8PAsV4
a href="bitcoin:1GLaEx3cU5rzaMVhst1djCJvs5HK8PAsV4?amount=0.05&label=asciinema%20donation" 1GLaEx3cU5rzaMVhst1djCJvs5HK8PAsV4
h3 Gratipay
p
' Gratipay is a way to give small weekly cash gifts to people you love and
are inspired by. And it's great for supporting open-source authors and
projects. To donate to Asciinema via Gratipay, click on the button below.
projects. To donate to asciinema via Gratipay, click on the button below.
<script data-gratipay-username="sickill" data-gratipay-widget="button" src="//grtp.co/v1.js"></script>
h3 PayPal
p
' You can also donate money to the project through Asciinema's PayPal
' You can also donate money to the project through asciinema's PayPal
account.
p
@ -69,7 +69,7 @@
<input type="hidden" name="cmd" value="_donations">
<input type="hidden" name="business" value="donations@asciinema.org">
<input type="hidden" name="lc" value="GB">
<input type="hidden" name="item_name" value="Asciinema development">
<input type="hidden" name="item_name" value="asciinema development">
<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted">
<input type="image" class="button" src="https://www.paypalobjects.com/en_GB/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal – The safer, easier way to pay online.">
<img alt="" border="0" src="https://www.paypalobjects.com/pl_PL/i/scr/pixel.gif" width="1" height="1">
@ -86,11 +86,6 @@
h2 id="packaging" Packaging
p
' Currently Asciinema recorder can be installed on any Linux and OS X
system with <code>pip</code> (it's a Python package at its core).
There are also native packages for Ubuntu and Arch Linux at the moment.
p
' If you use an operating system for which there's no native asciinema
package and you know how to build one then don't hesitate, build it and
@ -100,7 +95,7 @@
p
' All your bug reports and feature ideas are highly appreciated as they
help to improve the quality and functionality of Asciinema for everyone.
help to improve the quality and functionality of asciinema for everyone.
p
' As the service is built of 2 parts there are 2 separate bug trackers:
@ -125,7 +120,7 @@
= render 'shared/add_this',
url: root_url,
title: 'Asciinema - Record and share your terminal sessions, the right way',
title: 'asciinema - Record and share your terminal sessions, the right way',
big: true
.col-md-4