Skip to content
This repository has been archived by the owner on Oct 23, 2019. It is now read-only.

Improve the README #1

Merged
merged 1 commit into from
May 11, 2014
Merged
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
38 changes: 0 additions & 38 deletions README

This file was deleted.

36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
CaptainBern-Reflection-Framework
================================

This is a Java-Reflection and Bytecode Engineering library.

The goal of this project is to provide an easy way to work with Reflection on both a high and low level.

The Bytecode Engineering Lib (as for now "JBEL") can be used for Class-analysis and to create dynamic code on runtime.

One can also use it to, as example, parse a class, visit it with the build in visitor-api and dissemble the class.

The reflection framework was originally created to easily set and get fields and to invoke methods and constructors easier.

Content
=======

The Reflection framework is located in the `Reflection` folder and the Bytecode-library is located in the `JBEL` folder. That wasn't hard at all, was it?

Contributing
============

Prerequisites:

* When contributing to JBEL you need to have a basic understanding of bytecode.
* Spelling errors and grammar fixes don't require this so feel free to PR a fix for those.
* Some code contains basic documentation, some doesn't contain any documentation at all. Feel free to expand the documentation and please always document the code you add.
* Keep the side-notes in mind. When you notice a weird piece of code that doesn't make any sense to you, then please check if it has a side-note, if it has one then that will probably make clear what is happening there.

Everyone can contribute code to their liking. When making PR's please provide a brief description of what your code does, how it works and why it should be pulled.

* I generally follow the Sun/Oracle coding conventions.
* Feel free to ignore the "80 column limit"
* Curly braces should always be on the same line. (with one space in between)
* Make sure your code works
* When adding new classes please make sure you've added the license text above the class's package declaration.
* If you even consider contributing; Thanks!