Add documentation and license information

This commit is contained in:
Empathic Qubit 2022-12-31 22:22:42 +01:00
parent c58c8faac3
commit 437a8accd3
6 changed files with 89 additions and 2 deletions

17
LICENSE.md Normal file
View file

@ -0,0 +1,17 @@
Debug stub for Z80.
Copyright (C) 2022 Empathic Qubit.
Copyright (C) 2021-2022 Free Software Foundation, Inc.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.

View file

@ -9,3 +9,12 @@ functions in your program for it to compile:
Other functions will also be needed to do anything useful. Other functions will also be needed to do anything useful.
See [The template project for TI 8x calculators](https://github.com/empathicqubit/z88dk-ti8xp-template) for an example implementation. See [The template project for TI 8x calculators](https://github.com/empathicqubit/z88dk-ti8xp-template) for an example implementation.
# License
This project is licensed under GPLv3, in compliance with the original stub code.
In many cases this means if you distribute a binary file produced by this code,
you must provide the user the sources of all code which produced that binary file.
Please see [the license](LICENSE.md), and if you're not sure, don't use it.
It's quite large and slow, so you probably shouldn't be distributing it anyway,
only using it for debugging purposes.

View file

@ -1,3 +1,23 @@
/* Debug stub for Z80.
Copyright (C) 2022 Empathic Qubit.
Copyright (C) 2021-2022 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#include "lib.h" #include "lib.h"
#include "gdb.h" #include "gdb.h"

View file

@ -1,3 +1,23 @@
/* Debug stub for Z80.
Copyright (C) 2022 Empathic Qubit.
Copyright (C) 2021-2022 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#ifndef __GDB_GDB_H__ #ifndef __GDB_GDB_H__
#define __GDB_GDB_H__ #define __GDB_GDB_H__

View file

@ -1,7 +1,6 @@
/* This file contains stuff internal to the library */
/* Debug stub for Z80. /* Debug stub for Z80.
Copyright (C) 2022 Empathic Qubit.
Copyright (C) 2021-2022 Free Software Foundation, Inc. Copyright (C) 2021-2022 Free Software Foundation, Inc.
This file is part of GDB. This file is part of GDB.
@ -19,6 +18,8 @@
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */ along with this program. If not, see <http://www.gnu.org/licenses/>. */
/* This file contains stuff internal to the library */
#include "debug.h" #include "debug.h"
#include "lib.h" #include "lib.h"
#include "gdb.h" #include "gdb.h"

View file

@ -1,3 +1,23 @@
/* Debug stub for Z80.
Copyright (C) 2022 Empathic Qubit.
Copyright (C) 2021-2022 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#ifndef __GDB_LIB_H__ #ifndef __GDB_LIB_H__
#define __GDB_LIB_H__ #define __GDB_LIB_H__