Skip to content

Commit

Permalink
Merge #858 branch 'lukego/rename-in-readme' into fixes
Browse files Browse the repository at this point in the history
This is worth including as a fix because the master version of the
README.md file is currently serving as a landing page for the project.
  • Loading branch information
lukego committed Apr 20, 2016
2 parents 26b119c + e399381 commit ed2e399
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Snabb Switch
# Snabb

Snabb Switch is a simple and fast packet networking toolkit.
Snabb (formerly "Snabb Switch") is a simple and fast packet networking toolkit.

We are also a grassroots community of programmers and network
engineers who help each other to build and deploy new network
elements. We care about practical applications and finding simpler
ways to do things.

The Snabb Switch community are active in
The Snabb community are active in
[applying modern programming techniques](http://blog.ipspace.net/2014/09/snabb-switch-deep-dive-on-software-gone.html),
[do-it-yourself operator networking](http://blog.ipspace.net/2014/12/l2vpn-over-ipv6-with-snabb-switch-on.html),
[high-level device drivers](https://github.com/SnabbCo/snabbswitch/blob/master/src/apps/intel/intel10g.lua),
Expand All @@ -24,21 +24,21 @@ on.

## How does it work?

Snabb Switch is written using these main techniques:
Snabb is written using these main techniques:

- Lua, a high-level programming language that is easy to learn.
- LuaJIT, a just-in-time compiler that is competitive with C.
- Ethernet I/O with no kernel overhead ("kernel bypass" mode).

Snabb Switch compiles into a stand-alone executable called
Snabb compiles into a stand-alone executable called
`snabb`. This single binary includes multiple applications and runs on
any modern Linux distribution. (You could think of it as a
[busybox](http://en.wikipedia.org/wiki/BusyBox#Single_binary) for
networking.)

## How is it being used?

The first generation of Snabb Switch applications include:
The first generation of Snabb applications include:

### snabbnfv

Expand Down Expand Up @@ -84,13 +84,13 @@ or even directly on a Device Under Test.
### snsh

[snsh](src/program/snsh/) (Snabb Shell) is a tool for interactively
experimenting with Snabb Switch. It provides direct access to all APIs
experimenting with Snabb. It provides direct access to all APIs
using a Lua shell. You can operate snsh either from script files or
from an interactive shell.

## How do I get started?

Setting up a Snabb Switch development environment takes around one
Setting up a Snabb development environment takes around one
minute:

```
Expand All @@ -114,7 +114,7 @@ $ sudo snabb packetblaster replay capture.pcap 01:00.0

Here are the ways you can get involved:

- Use the Snabb Switch applications in your network.
- Use the Snabb applications in your network.
- Join the [snabb-devel mailing list](https://groups.google.com/forum/#!forum/snabb-devel).
- Send a mail to [introduce yourself](https://groups.google.com/forum/#!searchin/snabb-devel/introduce/snabb-devel/d8t6hGClnQY/flztyLiIGzoJ) to the community (don't be shy!).
- Create your very own application: [Getting Started](src/doc/getting-started.md).
Expand Down

0 comments on commit ed2e399

Please sign in to comment.