Giter VIP home page Giter VIP logo

excom's Introduction

excom Build Status

An alternative to current chat implementations.

Compiling

Before the project can be compiled, the configure script must be run. It generates a header file that is used by the project.

The project uses libtoml, which is under the 3 clause BSD license.

This project uses make. Sorry, I'm comfortable with make, and I know how to use it. However, building excom without make shouldn't be that difficult. Excom requires the c99 standard, excluding stdbool.h (it will use it if it can). Some defines and how you can use them:

Define Possible Values Meaning
EXCOM_NO_STDBOOL none If this is defined, excom will use its own stdbool implementation.
EXCOM_INCLUDE_SERVER_CLIENT none If this is defined, excom will include a very basic implementation of a server that can handle reading and writing to clients. It will not be able to handle anything more than that, though.
EXCOM_EPOLL none If this is defined, excom will try to use epoll.
EXCOM_KQUEUE none If this is defined, excom will try to use kqueue. If it does not exist on the system, the compiler will error with fatal error: sys/event.h: No such file or directory. Note: the support for kqueue in excom is still a little shakey, since I cannot test it in my current environment.

After you've defined what you need to, the main body of the code should be able to be compiled. The Makefile compiles it into a static library, but you can compile it into a shared object if you so wish.

Documentation

One of the primary goals of this library is to have 100% documentation - every function, every define, every struct. This is to ensure that the code is understandable as to how to use it. The code comes with a Doxyfile to allow doxygen to generate a site for the documentation.

Usage

Sadly, in the current state, the library can't really be used :(

But we're getting there!

Contribution

You wanna contribute? Awesome!

  1. Fork it (http://github.com/medcat/excom/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

excom's People

Contributors

haileys avatar teliosdev avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

excom's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.